<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: JSimpleDBFactory.html 842 2015-03-07 18:20:42Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.util.Arrays;<a name="line.10"></a>
<span class="sourceLineNo">011</span><a name="line.11"></a>
<span class="sourceLineNo">012</span>import org.jsimpledb.core.Database;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import org.jsimpledb.kv.simple.SimpleKVDatabase;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>/**<a name="line.15"></a>
<span class="sourceLineNo">016</span> * Factory for {@link JSimpleDB} instances.<a name="line.16"></a>
<span class="sourceLineNo">017</span> *<a name="line.17"></a>
<span class="sourceLineNo">018</span> * &lt;p&gt;<a name="line.18"></a>
<span class="sourceLineNo">019</span> * If no {@link Database} is configured, newly created {@link JSimpleDB} instances will use an initially empty,<a name="line.19"></a>
<span class="sourceLineNo">020</span> * in-memory {@link SimpleKVDatabase}.<a name="line.20"></a>
<span class="sourceLineNo">021</span> * &lt;/p&gt;<a name="line.21"></a>
<span class="sourceLineNo">022</span> *<a name="line.22"></a>
<span class="sourceLineNo">023</span> * @see JSimpleDB<a name="line.23"></a>
<span class="sourceLineNo">024</span> */<a name="line.24"></a>
<span class="sourceLineNo">025</span>public class JSimpleDBFactory {<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>    private Database database;<a name="line.27"></a>
<span class="sourceLineNo">028</span>    private int schemaVersion;<a name="line.28"></a>
<span class="sourceLineNo">029</span>    private StorageIdGenerator storageIdGenerator = new DefaultStorageIdGenerator();<a name="line.29"></a>
<span class="sourceLineNo">030</span>    private Iterable&lt;? extends Class&lt;?&gt;&gt; modelClasses;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>    /**<a name="line.32"></a>
<span class="sourceLineNo">033</span>     * Configure the Java model classes.<a name="line.33"></a>
<span class="sourceLineNo">034</span>     *<a name="line.34"></a>
<span class="sourceLineNo">035</span>     * &lt;p&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span>     * Note: {@link org.jsimpledb.annotation.JSimpleClass &amp;#64;JSimpleClass}-annotated super-types of any<a name="line.36"></a>
<span class="sourceLineNo">037</span>     * class in {@code modelClasses} will be included, even if the super-type is not explicitly specified in {@code modelClasses}.<a name="line.37"></a>
<span class="sourceLineNo">038</span>     * &lt;/p&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span>     *<a name="line.39"></a>
<span class="sourceLineNo">040</span>     * @param modelClasses classes annotated with {@link org.jsimpledb.annotation.JSimpleClass &amp;#64;JSimpleClass} annotations<a name="line.40"></a>
<span class="sourceLineNo">041</span>     * @return this instance<a name="line.41"></a>
<span class="sourceLineNo">042</span>     */<a name="line.42"></a>
<span class="sourceLineNo">043</span>    public JSimpleDBFactory setModelClasses(Iterable&lt;? extends Class&lt;?&gt;&gt; modelClasses) {<a name="line.43"></a>
<span class="sourceLineNo">044</span>        this.modelClasses = modelClasses;<a name="line.44"></a>
<span class="sourceLineNo">045</span>        return this;<a name="line.45"></a>
<span class="sourceLineNo">046</span>    }<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span>    /**<a name="line.48"></a>
<span class="sourceLineNo">049</span>     * Configure the Java model classes.<a name="line.49"></a>
<span class="sourceLineNo">050</span>     *<a name="line.50"></a>
<span class="sourceLineNo">051</span>     * &lt;p&gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span>     * Equivalent to {@link #setModelClasses(Iterable) setModelClasses}{@code (Arrays.asList(modelClasses))}.<a name="line.52"></a>
<span class="sourceLineNo">053</span>     * &lt;/p&gt;<a name="line.53"></a>
<span class="sourceLineNo">054</span>     *<a name="line.54"></a>
<span class="sourceLineNo">055</span>     * @param modelClasses classes annotated with {@link org.jsimpledb.annotation.JSimpleClass &amp;#64;JSimpleClass} annotations<a name="line.55"></a>
<span class="sourceLineNo">056</span>     * @return this instance<a name="line.56"></a>
<span class="sourceLineNo">057</span>     * @see #setModelClasses(Iterable)<a name="line.57"></a>
<span class="sourceLineNo">058</span>     */<a name="line.58"></a>
<span class="sourceLineNo">059</span>    public JSimpleDBFactory setModelClasses(Class&lt;?&gt;... modelClasses) {<a name="line.59"></a>
<span class="sourceLineNo">060</span>        return this.setModelClasses(Arrays.asList(modelClasses));<a name="line.60"></a>
<span class="sourceLineNo">061</span>    }<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span>    /**<a name="line.63"></a>
<span class="sourceLineNo">064</span>     * Configure the underlying {@link Database} for this instance.<a name="line.64"></a>
<span class="sourceLineNo">065</span>     *<a name="line.65"></a>
<span class="sourceLineNo">066</span>     * &lt;p&gt;<a name="line.66"></a>
<span class="sourceLineNo">067</span>     * By default this instance will use an initially empty, in-memory {@link SimpleKVDatabase}.<a name="line.67"></a>
<span class="sourceLineNo">068</span>     * &lt;/p&gt;<a name="line.68"></a>
<span class="sourceLineNo">069</span>     *<a name="line.69"></a>
<span class="sourceLineNo">070</span>     * @param database core API database to use<a name="line.70"></a>
<span class="sourceLineNo">071</span>     * @return this instance<a name="line.71"></a>
<span class="sourceLineNo">072</span>     */<a name="line.72"></a>
<span class="sourceLineNo">073</span>    public JSimpleDBFactory setDatabase(Database database) {<a name="line.73"></a>
<span class="sourceLineNo">074</span>        this.database = database;<a name="line.74"></a>
<span class="sourceLineNo">075</span>        return this;<a name="line.75"></a>
<span class="sourceLineNo">076</span>    }<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span>    /**<a name="line.78"></a>
<span class="sourceLineNo">079</span>     * Configure the schema version number associated with the configured Java model classes.<a name="line.79"></a>
<span class="sourceLineNo">080</span>     *<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * &lt;p&gt;<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * A value of zero means to use whatever is the highest version already recorded in the database.<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * However, if this instance has no {@link Database} configured, then an empty<a name="line.83"></a>
<span class="sourceLineNo">084</span>     * {@link SimpleKVDatabase} is used and therefore a schema version of {@code 1} is assumed.<a name="line.84"></a>
<span class="sourceLineNo">085</span>     * &lt;/p&gt;<a name="line.85"></a>
<span class="sourceLineNo">086</span>     *<a name="line.86"></a>
<span class="sourceLineNo">087</span>     * @param schemaVersion the schema version number of the schema derived from the configured Java model classes,<a name="line.87"></a>
<span class="sourceLineNo">088</span>     *  or zero to default to the highest version already recorded in the database<a name="line.88"></a>
<span class="sourceLineNo">089</span>     * @return this instance<a name="line.89"></a>
<span class="sourceLineNo">090</span>     */<a name="line.90"></a>
<span class="sourceLineNo">091</span>    public JSimpleDBFactory setSchemaVersion(int schemaVersion) {<a name="line.91"></a>
<span class="sourceLineNo">092</span>        this.schemaVersion = schemaVersion;<a name="line.92"></a>
<span class="sourceLineNo">093</span>        return this;<a name="line.93"></a>
<span class="sourceLineNo">094</span>    }<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span>    /**<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * Configure the {@link StorageIdGenerator} for auto-generating storage ID's when not explicitly<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * specified in {@link org.jsimpledb.annotation.JSimpleClass &amp;#64;JSimpleClass},<a name="line.98"></a>
<span class="sourceLineNo">099</span>     * {@link org.jsimpledb.annotation.JField &amp;#64;JField}, etc., annotations.<a name="line.99"></a>
<span class="sourceLineNo">100</span>     *<a name="line.100"></a>
<span class="sourceLineNo">101</span>     * &lt;p&gt;<a name="line.101"></a>
<span class="sourceLineNo">102</span>     * This instance will initially be configured with a {@link DefaultStorageIdGenerator}.<a name="line.102"></a>
<span class="sourceLineNo">103</span>     * To disable auto-generation of storage ID's altogether, configure a null value here.<a name="line.103"></a>
<span class="sourceLineNo">104</span>     * &lt;/p&gt;<a name="line.104"></a>
<span class="sourceLineNo">105</span>     *<a name="line.105"></a>
<span class="sourceLineNo">106</span>     * @param storageIdGenerator storage ID generator, or null to disable auto-generation of storage ID's<a name="line.106"></a>
<span class="sourceLineNo">107</span>     * @return this instance<a name="line.107"></a>
<span class="sourceLineNo">108</span>     */<a name="line.108"></a>
<span class="sourceLineNo">109</span>    public JSimpleDBFactory setStorageIdGenerator(StorageIdGenerator storageIdGenerator) {<a name="line.109"></a>
<span class="sourceLineNo">110</span>        this.storageIdGenerator = storageIdGenerator;<a name="line.110"></a>
<span class="sourceLineNo">111</span>        return this;<a name="line.111"></a>
<span class="sourceLineNo">112</span>    }<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span>    /**<a name="line.114"></a>
<span class="sourceLineNo">115</span>     * Construct a {@link JSimpleDB} instance using this instance's configuration.<a name="line.115"></a>
<span class="sourceLineNo">116</span>     *<a name="line.116"></a>
<span class="sourceLineNo">117</span>     * @return newly created {@link JSimpleDB} database<a name="line.117"></a>
<span class="sourceLineNo">118</span>     * @throws IllegalArgumentException if this instance has an incomplete or invalid configuration<a name="line.118"></a>
<span class="sourceLineNo">119</span>     * @throws IllegalArgumentException if any Java model class has an invalid annotation<a name="line.119"></a>
<span class="sourceLineNo">120</span>     */<a name="line.120"></a>
<span class="sourceLineNo">121</span>    public JSimpleDB newJSimpleDB() {<a name="line.121"></a>
<span class="sourceLineNo">122</span>        Database database1 = this.database;<a name="line.122"></a>
<span class="sourceLineNo">123</span>        int schemaVersion1 = this.schemaVersion;<a name="line.123"></a>
<span class="sourceLineNo">124</span>        if (database1 == null) {<a name="line.124"></a>
<span class="sourceLineNo">125</span>            database1 = new Database(new SimpleKVDatabase());<a name="line.125"></a>
<span class="sourceLineNo">126</span>            if (schemaVersion1 == 0)<a name="line.126"></a>
<span class="sourceLineNo">127</span>                schemaVersion1 = 1;<a name="line.127"></a>
<span class="sourceLineNo">128</span>        }<a name="line.128"></a>
<span class="sourceLineNo">129</span>        return new JSimpleDB(database1, schemaVersion1, this.storageIdGenerator, this.modelClasses);<a name="line.129"></a>
<span class="sourceLineNo">130</span>    }<a name="line.130"></a>
<span class="sourceLineNo">131</span>}<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>




























































</pre>
</div>
</body>
</html>
